<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SC2API: include/sc2api/sc2_game_settings.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="SC2-Logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SC2API
   </div>
   <div id="projectbrief">An API for AI for StarCraft II</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_3d0dfd3160b31ffa512c49330ac8d646.html">sc2api</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">sc2_game_settings.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;</div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="sc2__gametypes_8h.html">sc2api/sc2_gametypes.h</a>&quot;</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacesc2.html">sc2</a> {</div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="structsc2_1_1_process_info.html">   11</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structsc2_1_1_process_info.html">ProcessInfo</a> {</div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;    std::string process_path;</div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;    uint64_t process_id;</div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;    <span class="keywordtype">int</span> port;</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;};</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="structsc2_1_1_process_settings.html">   18</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structsc2_1_1_process_settings.html">ProcessSettings</a> {</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;    <a class="code" href="structsc2_1_1_process_settings.html">ProcessSettings</a>(<span class="keywordtype">bool</span> in_real_time,</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;        <span class="keywordtype">int</span> in_step_size,</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;        <span class="keyword">const</span> std::string&amp; in_process_path,</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;        <span class="keyword">const</span> std::string&amp; in_net_address,</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;        <span class="keywordtype">int</span> in_timeout_ms,</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;        <span class="keywordtype">int</span> in_port_start,</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;        <span class="keywordtype">bool</span> in_multi_threaded = <span class="keyword">false</span>);</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    <span class="keywordtype">bool</span> realtime;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    <span class="keywordtype">int</span> step_size;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    std::string process_path;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;    std::string net_address;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <span class="keywordtype">int</span> timeout_ms;</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    <span class="keywordtype">int</span> port_start;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    <span class="comment">// Run all OnSteps in parallel.</span></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    <span class="keywordtype">bool</span> multi_threaded;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    std::vector&lt;std::string&gt; extra_command_lines;</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    <span class="comment">// PID and port of all running sc2 processes.</span></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    std::vector&lt;ProcessInfo&gt; process_info;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;};</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structsc2_1_1_render_settings.html">   41</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structsc2_1_1_render_settings.html">RenderSettings</a> {</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    <a class="code" href="structsc2_1_1_render_settings.html">RenderSettings</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <a class="code" href="structsc2_1_1_render_settings.html">RenderSettings</a>(<span class="keywordtype">int</span> map_x, <span class="keywordtype">int</span> map_y, <span class="keywordtype">int</span> minimap_x, <span class="keywordtype">int</span> minimap_y)</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;        : map_x(map_x), map_y(map_y), minimap_x(minimap_x), minimap_y(minimap_y)</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    {}</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structsc2_1_1_render_settings.html#a330b0d96688b42703928e26e0feb305f">   47</a></span>&#160;    <span class="keywordtype">int</span> map_x = 800;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structsc2_1_1_render_settings.html#ac565d5076b37c1ad8d6a7896900af9f7">   49</a></span>&#160;    <span class="keywordtype">int</span> map_y = 600;</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structsc2_1_1_render_settings.html#a9c0da03ae27b40786ed3b78b978731ca">   51</a></span>&#160;    <span class="keywordtype">int</span> minimap_x = 300;</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structsc2_1_1_render_settings.html#af939a393029d7cb7c899e7da543b8bb4">   53</a></span>&#160;    <span class="keywordtype">int</span> minimap_y = 300;</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;};</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structsc2_1_1_feature_layer_settings.html">   57</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structsc2_1_1_feature_layer_settings.html">FeatureLayerSettings</a> {</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    <a class="code" href="structsc2_1_1_feature_layer_settings.html">FeatureLayerSettings</a> () = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    <a class="code" href="structsc2_1_1_feature_layer_settings.html">FeatureLayerSettings</a> (<span class="keywordtype">float</span> in_camera_width, <span class="keywordtype">int</span> in_map_x, <span class="keywordtype">int</span> in_map_y, <span class="keywordtype">int</span> in_minimap_x, <span class="keywordtype">int</span> in_minimap_y)</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;        : camera_width(in_camera_width), map_x(in_map_x), map_y(in_map_y), minimap_x(in_minimap_x), minimap_y(in_minimap_y)</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    {}</div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structsc2_1_1_feature_layer_settings.html#a3d585889888f6fab4324992fb74f4d32">   63</a></span>&#160;    <span class="keywordtype">float</span> camera_width = 24.0f;</div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="structsc2_1_1_feature_layer_settings.html#a621c94ea8be82e725ea0632126587067">   65</a></span>&#160;    <span class="keywordtype">int</span> map_x = 64;</div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="structsc2_1_1_feature_layer_settings.html#a17b45c8a4de7ff44bb18d79de5fe4532">   67</a></span>&#160;    <span class="keywordtype">int</span> map_y = 64;</div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="structsc2_1_1_feature_layer_settings.html#a22ff2b541326b90567bb1f8986f8fe68">   69</a></span>&#160;    <span class="keywordtype">int</span> minimap_x = 64;</div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="structsc2_1_1_feature_layer_settings.html#a8cf3d9f547f3fca567f443e8081bfb4f">   71</a></span>&#160;    <span class="keywordtype">int</span> minimap_y  = 64;</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;};</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="structsc2_1_1_interface_settings.html">   75</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structsc2_1_1_interface_settings.html">InterfaceSettings</a> {</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <a class="code" href="structsc2_1_1_interface_settings.html">InterfaceSettings</a>();</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    <span class="keywordtype">bool</span> use_feature_layers;</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    <a class="code" href="structsc2_1_1_feature_layer_settings.html">FeatureLayerSettings</a> feature_layer_settings;</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <span class="keywordtype">bool</span> use_render;</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    <a class="code" href="structsc2_1_1_render_settings.html">RenderSettings</a> render_settings;</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;};</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="structsc2_1_1_game_settings.html">   85</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structsc2_1_1_game_settings.html">GameSettings</a> {</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    <a class="code" href="structsc2_1_1_game_settings.html">GameSettings</a>();</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    std::string map_name;</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;    std::vector&lt;PlayerSetup&gt; player_setup;</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    <a class="code" href="structsc2_1_1_ports.html">Ports</a> ports;</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;};</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="structsc2_1_1_replay_settings.html">   94</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structsc2_1_1_replay_settings.html">ReplaySettings</a> {</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;    <a class="code" href="structsc2_1_1_replay_settings.html">ReplaySettings</a>();</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;    <span class="comment">// Fill with replays to analyze.</span></div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;    std::vector&lt;std::string&gt; replay_file;</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    std::string replay_dir;</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;    uint32_t player_id;</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;};</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="keyword">enum class</span> AppState {</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;    normal,         <span class="comment">// The game application has behaved normally.</span></div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;    timeout,        <span class="comment">// A timeout has occurred, and the game application was terminated.</span></div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    timeout_zombie, <span class="comment">// A timeout has occurred, but the game application could not be terminated.</span></div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;    crashed         <span class="comment">// A crash has been detected.</span></div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;};</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* kMapBelShirVestigeLE;</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* kMapEmpty;</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* kMapEmptyLong;</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* kMapEmptyTall;</div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* kMapMarineMicro;</div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;}</div><div class="ttc" id="structsc2_1_1_render_settings_html"><div class="ttname"><a href="structsc2_1_1_render_settings.html">sc2::RenderSettings</a></div><div class="ttdoc">Settings for an RGB rendered output. </div><div class="ttdef"><b>Definition:</b> sc2_game_settings.h:41</div></div>
<div class="ttc" id="structsc2_1_1_process_info_html"><div class="ttname"><a href="structsc2_1_1_process_info.html">sc2::ProcessInfo</a></div><div class="ttdoc">Information about a running process. </div><div class="ttdef"><b>Definition:</b> sc2_game_settings.h:11</div></div>
<div class="ttc" id="namespacesc2_html"><div class="ttname"><a href="namespacesc2.html">sc2</a></div><div class="ttdef"><b>Definition:</b> sc2_action.h:9</div></div>
<div class="ttc" id="structsc2_1_1_interface_settings_html"><div class="ttname"><a href="structsc2_1_1_interface_settings.html">sc2::InterfaceSettings</a></div><div class="ttdoc">Settings for rendered feature layer output. </div><div class="ttdef"><b>Definition:</b> sc2_game_settings.h:75</div></div>
<div class="ttc" id="structsc2_1_1_process_settings_html"><div class="ttname"><a href="structsc2_1_1_process_settings.html">sc2::ProcessSettings</a></div><div class="ttdoc">Settings to run the game process. </div><div class="ttdef"><b>Definition:</b> sc2_game_settings.h:18</div></div>
<div class="ttc" id="structsc2_1_1_ports_html"><div class="ttname"><a href="structsc2_1_1_ports.html">sc2::Ports</a></div><div class="ttdoc">Port setup for one or more clients in a game. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:105</div></div>
<div class="ttc" id="sc2__gametypes_8h_html"><div class="ttname"><a href="sc2__gametypes_8h.html">sc2_gametypes.h</a></div><div class="ttdoc">Types used in setting up a game. </div></div>
<div class="ttc" id="structsc2_1_1_replay_settings_html"><div class="ttname"><a href="structsc2_1_1_replay_settings.html">sc2::ReplaySettings</a></div><div class="ttdoc">Settings for starting a replay. </div><div class="ttdef"><b>Definition:</b> sc2_game_settings.h:94</div></div>
<div class="ttc" id="structsc2_1_1_feature_layer_settings_html"><div class="ttname"><a href="structsc2_1_1_feature_layer_settings.html">sc2::FeatureLayerSettings</a></div><div class="ttdoc">Settings for feature layer output. </div><div class="ttdef"><b>Definition:</b> sc2_game_settings.h:57</div></div>
<div class="ttc" id="structsc2_1_1_game_settings_html"><div class="ttname"><a href="structsc2_1_1_game_settings.html">sc2::GameSettings</a></div><div class="ttdoc">Settings for starting a game. </div><div class="ttdef"><b>Definition:</b> sc2_game_settings.h:85</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
